/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.druid.security.basic.authentication.db.updater;

import org.apache.druid.security.basic.authentication.entity.BasicAuthenticatorCredentialUpdate;
import org.apache.druid.security.basic.authentication.entity.BasicAuthenticatorUser;

import java.util.Map;

/**
 * Implementations of this interface are responsible for connecting directly to the metadata storage,
 * modifying the authenticator database state or reading it. This interface is used by the
 * MetadataStoragePollingBasicAuthenticatorCacheManager (for reads) and the CoordinatorBasicAuthenticatorResourceHandler
 * (for handling configuration read/writes).
 */
public interface BasicAuthenticatorMetadataStorageUpdater
{
  void createUser(String prefix, String userName);

  void deleteUser(String prefix, String userName);

  void setUserCredentials(String prefix, String userName, BasicAuthenticatorCredentialUpdate update);

  Map<String, BasicAuthenticatorUser> getCachedUserMap(String prefix);

  byte[] getCachedSerializedUserMap(String prefix);

  byte[] getCurrentUserMapBytes(String prefix);

  void refreshAllNotification();
}
